home *** CD-ROM | disk | FTP | other *** search
/ Netware Super Library / Netware Super Library.iso / file_mgt / gledit / gledit.doc next >
Encoding:
Text File  |  1995-03-20  |  41.9 KB  |  947 lines

  1.                                     GLEDIT
  2.                               Global File Editor
  3.                                  USER'S GUIDE
  4.  
  5.                        Copyright 1990 by Gary C. Crider
  6.  
  7.  
  8.  
  9. TABLE OF CONTENTS:
  10.  
  11.         What is GLEDIT? ..................................  1.0
  12.         The GLEDIT Command Line ..........................  2.0
  13.         The GLEDIT Text Mode User Interface ..............  3.0
  14.           The Primary Data Entry Screen ..................  3.1
  15.           Data Entry .....................................  3.2
  16.           The Options Selection Window ...................  3.3
  17.           Context-Sensitive Help .........................  3.4
  18.         Inputing Search/Replace Strings from a File ......  4.0
  19.         Escape Sequences for Special Characters ..........  5.0
  20.         Operational Notes and Cautions ...................  6.0
  21.         Locating Data ....................................  7.0
  22.         Modifying Data ...................................  8.0
  23.         Printing or Saving the Output ....................  9.0
  24.         Return Codes ..................................... 10.0
  25.         Compatibility with Prior Releases ................ 11.0
  26.         The GLEDIT.INI Configuration File ................ 12.0
  27.         Installation ..................................... Appendix A
  28.         Disclaimer ....................................... Appendix B
  29.         Support .......................................... Appendix C
  30.         Registration ..................................... Appendix D
  31.  
  32.  
  33. 1.0 What Is GLEDIT?
  34.  
  35.    GLEDIT lets you globally search for, and optionally replace, a string of
  36. characters in all selected files a directory or directory tree.  If you have
  37. used any text search utilities, you know the power of being able to search 
  38. all .BAT files in your BATCH directory when you move some applications to a 
  39. new disk volume.  You are able to tell immediately which batch files need to 
  40. be modified.
  41.  
  42.    GLEDIT takes it a step further in letting you also specify the string that
  43. is to replace the search string and does the update of the file for you.  It
  44. prompts you before changing each line that may require modification.  Option-
  45. ally, the prompting may be supressed.
  46.  
  47.  
  48.  
  49.  
  50. 2.0 The GLEDIT Command Line
  51.  
  52.    If GLEDIT is entered at the command line with no parameters, the GLEDIT
  53. text mode user interface will be invoked.  It is a full screen, windowed
  54. interface to using GLEDIT with context-sensitive help.  Please see the next
  55. section if you wish to use the interface.
  56.  
  57.    GLEDIT can also have all of its parameters input on the command line if
  58. the search and/or replace strings are not too long.
  59.  
  60. Format:
  61.    GLEDIT [path]filespec "searchstring" ["replacestring"] [switches]
  62.  
  63.    The "filespec" is the file name of the file that you want to search or
  64. edit.  If the "filespec" is a wildcard specification, all matching files in
  65. "path" will be searched/edited.  If "path" is not specified, the current
  66. directory is used.  If a mapped network directory is used for the path, the
  67. full directory path should be specified, rather than just the drive letter.
  68. For example, use W:\UTIL\*.* rather than W:*.* if W: is mapped to the UTIL
  69. directory.  Do not use the actual network drive names in the path such as
  70. APPL:\UTIL\*.*.
  71.  
  72.    The "searchstring" is the string of characters to look for in each 
  73. matching file.  It should be enclosed in quotes if it contains spaces, commas 
  74. or characters other than letters or numbers. 
  75.  
  76.    The "replacestring" is the new string to be inserted in place of the
  77. "searchstring".  It does not have to be the same length as the "searchstring".
  78. The new record length will be adjusted to accommodate the replacement.  It 
  79. should be enclosed in quotes if it contains spaces, <, >, |, or /.  If you 
  80. specify "" as the "replacestring", then nothing is inserted in place of the 
  81. "searchstring", in effect deleting it from the record. 
  82.  
  83.    Either string may contain quotes by using the ~q escape sequence described
  84. in the next section.  See the section, "Escape Sequences for Special 
  85. Characters" for information on including quotes within the search or replace 
  86. string.  Also see the section, "The GLEDIT Text Mode User Interface" regarding 
  87. the use of quotes in strings input via the interface.
  88.  
  89.    The replace string may not be exactly the same as a switch (see below), 
  90. unless enclosed in quotes.  The switch characters may also be embedded within 
  91. a replace string.
  92.  
  93.    See section 2.1 for instructions on inputing the search and/or replace
  94. strings from a file.
  95.  
  96.  
  97. Switches:
  98.  
  99.    /I indicates case-insensitive searching where the search argument and the
  100. target record will match if they contain the same letters regardless of
  101. upper or lower case.  /I has no effect on "replacestring".  The "replace-
  102. string" is inserted as entered in the command line.
  103.  
  104.    /N directs output to the standard output device (normally the display).
  105. GLEDIT normally writes to the screen with color highlighting of the matched
  106. string.  Output directed to the screen cannot be redirected to another
  107. device.  The standard output can be directed to another device such as
  108. a file or printer.  If you specify /N and do not redirect the output, it
  109. will appear on the screen without color highlighting.
  110.  
  111.    /D causes matching lines to be deleted.  Prompting occurs unless /Y
  112. is specified.
  113.  
  114.    /S in most instances, causes information to be sent to the screen contin-
  115. uously, with no pauses when the screen gets full, or a new file is processed.
  116. Scrolling depends on both /S, /Y and the mode of operation.  See the table
  117. in "Operational Notes and Cautions" for specifics of how this parameter will
  118. impact the display.
  119.  
  120.    /Y is used to automatically reply Y to the replace prompts when in
  121. edit (replace) mode.  Please see "Operational Notes and Cautions" before
  122. using this parameter.  It is ignored in search  mode. Screen scrolling depends
  123. on both /S, /Y and the operational mode.  See the table in "Operational Notes
  124. and Cautions" for specifics of how this parameter will impact the display.
  125.  
  126.    /T (test mode) performs normally except that no changes are actually made
  127. to any files.  You can test the results before proceeding. /T is ignored in
  128. search mode.  Some messages are slightly modified to indicate that the
  129. changes are not actually made.
  130.  
  131.    /P tells GLEDIT that this is a search mode run only, and the only thing
  132. displayed will be the path and filename of any files which conatin the search
  133. string.  If /P is specified, the replace string is ignored as are the /T, /Y,
  134. and /D switches.
  135.  
  136.    /R tells GLEDIT to search the current directory and all subdirectories 
  137. subordinate to the current directory.
  138.  
  139.  
  140. 3.0 The GLEDIT Text Mode User Interface
  141.  
  142.    If GLEDIT is entered at the command line with no parameters, the GLEDIT
  143. text mode user interface will be invoked.  It is a full screen, windowed
  144. interface to using GLEDIT.  Not just a front-end, the user interface is a
  145. container that completely envelopes GLEDIT with easy entry of search
  146. parameters, option setting and context-sensitive help.
  147.  
  148.    In following sections, if there are any differences in operation or
  149. results in the user interface and command line mode, a notation will be
  150. made relating the differences.
  151.  
  152.  
  153. 3.1 The Primary Data Entry Screen
  154.  
  155. Typing GLEDIT with no parameters invokes the data entry screen which allows
  156. you to enter the file path and filename/wildcard mask, and the search and
  157. replace strings up to 512 bytes each.
  158.  
  159. The path field tells GLEDIT what file(s) to search/edit.  It may contain any
  160. valid DOS drive/path/filename, path/filename or just filename.  The filemane
  161. may be a wildcard construct, using normal DOS wildcard conventions.  If the
  162. drive and/or path is omitted, the current drive and/or path is assumed.  If
  163. the path is a wildcard specification, all matching files in the directory
  164. (and subdirectories if the recurse option is selected)  will be searched
  165. and, optionally, edited.
  166.  
  167. If a mapped network directory is used for the path, the full directory path
  168. should be specified, rather than just the drive letter.  For example, use
  169. W:\UTIL\*.* rather than W:*.* if W: is mapped to the UTIL directory.  Do not
  170. use the actual network drive names in the path such as APPL:\UTIL\*.*.
  171.  
  172. The path field may not be left blank.  Up to 64 characters, upper or lower
  173. case may be entered.
  174.  
  175. The search string is the string of characters to look for in each requested
  176. file.
  177.  
  178. The search string field may not be left blank.  Up to 512 characters, upper or
  179. lower case may be entered.
  180.  
  181. The replace string is the new string to be inserted in place of the search
  182. string.  It does not have to be the same length as the search string.  The
  183. new record length will be adjusted to accommodate the replacement.  If you
  184. specify the string "" as the replace string, then nothing is inserted in
  185. place of the search string, in effect deleting it from the record.
  186.  
  187. The replace string field may be left blank to indicate that search mode is
  188. being invoked.  Up to 512 characters, upper or lower case may be entered.
  189.  
  190. The search and replace string fields are actually made up of eight fields
  191. each that are combined into one field for GLEDIT.  Type the information
  192. continuously, continuing words across the end of a line just as if the
  193. multiple lines were really one long line.  Don't deliberately break between
  194. words like a word processor would do.  When the field is built for
  195. processing by GLEDIT, trailing blank lines are discarded, the remaining
  196. lines are concatenated together, and trailing blanks are removed.  Lastly,
  197. one quote is removed from the front and back of the field if they exist.
  198. This is to allow trailing blanks in the search string.
  199.  
  200.  
  201. 3.2 Data Entry
  202.  
  203. To enter data in a field, move the cursor to the field by using the TAB,
  204. ENTER or up and down arrow keys.  TAB and ENTER move the cursor down the
  205. window to the beginning of each input field. The up and down arrows move
  206. up or down to the next line or field.
  207.  
  208. You may now enter your new information in the field.  Press ENTER or TAB
  209. to move to the next field.  F10 accepts all input and processes the screen
  210. when pressed in any field.
  211.  
  212. Pressing ESC allows you to cancel any input and exit the data entry window.
  213.  
  214. If, after entering data in a field, the cursor does not proceed to the next
  215. field, there is an error in the data entered in the field.  Each field is
  216. audited to make sure that what you enter is acceptable to the program.
  217.  
  218. If you try to enter a character and nothing appears on the screen and the
  219. cursor remains stationary, it is because you are trying to enter a character
  220. which is not acceptable in that position of the field.  For instance, nothing
  221. will happen when you try to type "1" in the OPTIONS fields which only accept
  222. "X" or space.
  223.  
  224.    Input Field Editing Keys:
  225.  
  226.      Left Arrow         Cursor left
  227.      Right Arrow        Cursor right
  228.      Up Arrow           Cursor up
  229.      Down Arrow         Cursor down
  230.      CTRL-Left Arrow    Word left
  231.      CTRL-Right Arrow   Word right
  232.      Tab                Field right
  233.      SHIFT-Tab          Field left
  234.      Enter (Return)     Process field
  235.      CTRL-Enter         Process screen
  236.      Decimal (.)        Move to right of decimal
  237.      Home               Beginning of field
  238.      End                End of field data
  239.      CTRL-Home          Beginning of first field
  240.      CTRL-End           End of last field
  241.      Insert             Toggle insert mode on/off
  242.      Delete             Delete character at cursor
  243.      Backspace          Delete character left of cursor
  244.      CTRL-Backspace     Delete word to left of cursor
  245.      CTRL-R             Restore field to original contents
  246.      CTRL-T             Delete word to right of cursor
  247.      CTRL-U             Delete to end of field
  248.      CTRL-Y             Delete to end of last field
  249.      Esc                Abort data entry.
  250.      F10                Process screen (On data entry window)
  251.      F10                Select for update (On browse window)
  252.  
  253.  
  254. 3.3 The Options Selection Window
  255.  
  256.  
  257. The options window allows you to modify certain parameters of a given search/
  258. replace session.  These are mostly the same options that are available on the
  259. GLEDIT command line.
  260.  
  261. To select/deselect an option, place an 'X' or space respectively in the box
  262. beside the option.  You can set your own default options in GLEDIT.INI.
  263.  
  264. The "Ignore case" option lets you determine if caps/lower case should be
  265. considered in searching.  If you place an 'X' in this box, a case-insensitive
  266. search is performed.  Replace strings always retain their case as entered.
  267.  
  268. The "Delete matching records" option allows you to delete records which
  269. contain matches to the search string. Placing an 'X' in this box puts GLEDIT
  270. in delete mode.
  271.  
  272.  
  273. The "Scroll window without pause" option controls whether the screen scroll
  274. will pause when the screen is full or the searched file changes.  The actual
  275. effect of this parameter, or lack of it, varies depending on whether you are
  276. in search, replace or delete mode and the status of the "Prompt before action"
  277. option.  To see how use of this parameter will effect operation, use the
  278. "Test mode option" or refer to the table in the "Operational Notes and
  279. Cautions" section.
  280.  
  281. The "Prompt before action option" determines whether or not you will be
  282. prompted before a replace or delete takes place.  Placing an X in this box
  283. forces GLEDIT to query you prior to making each change in the file.  If this
  284. option is turned off, no such query is made and the replacement/deletion takes
  285. place.
  286.  
  287. The "Test mode" option allows you to operate GLEDIT normally except that no
  288. changes are actually made to the file.  You can see the results beforehand.
  289. Place an 'X' in this box to prevent file modifications.
  290.  
  291.  
  292. The "Recurse subdirectories" option will allow you to search files in all
  293. levels of the directory tree including and subordinate to the specified
  294. directory.  Placing an 'X' in this box tells GLEDIT to search all sub-
  295. ordinate directories as well as the current directory.
  296.  
  297.  
  298. The "Show paths/filenaes only" parameter tells GLEDIT that this is a search 
  299. mode run only, and the only thing displayed will be the path and filename of 
  300. any files which conatin the search string.  If specified, the replace string 
  301. is ignored as are the "test mode", "Prompt before action" and "Delete 
  302. matching records options.
  303.  
  304.  
  305. 3.4 Context-Sensitive Help
  306.  
  307. One of the primary advantages to using the user interface is that help
  308. is just a keypress away.
  309.  
  310. To enter the Help function, place the cursor on the field for which you
  311. need help and press F1.
  312.  
  313. Exit help at any time by pressing ESC.  Page Down and Page up can be used
  314. to view multiple pages of a single help category.
  315.  
  316. Other help categories will be displayed at the end of the help screen which
  317. may also contain information concerning the item you have selected.  To
  318. access these categories, move between them with the arrow keys and press
  319. ENTER to select the one you want.
  320.  
  321. The help index contains all help categories, each of which is selectable by
  322. using the arrow keys and ENTER.
  323.  
  324.  
  325. 4.0 Inputing Search/Replace Strings from a File
  326.  
  327.   You can avoid the limitation imposed by the DOS command line length by
  328. telling GLEDIT to get the search string and/or the replace string from
  329. a file, rather than directly from the command line.  This even works
  330. in the user interface mode, although the benefits are less readily
  331. discernable.
  332.  
  333.   First, prepare an ASCII text file (not a word processor format file) with
  334. any text editor.  This file should contain a single line up to 512 characters 
  335. long that will be the search or replace string.  If it contains leading or
  336. trailing blanks, enclose the string in quotes.
  337.  
  338.   You then reference the file path/name in the command line in place of the
  339. search or replace string parameter by preceding the file path/name with @.
  340. For example, if you want to replace the string "all good men" with a string
  341. in AGM.TXT in the current directory, the command line would look like this:
  342.  
  343.    GLEDIT *.TXT "all good men" @AGM.TXT
  344.  
  345.   Or if you wanted to search for the string in AGM.TXT and replace it with
  346. "all good men", and the AGM.TXT file is in the D drive root directory (not
  347. the current directory), the command line would look like this:
  348.   
  349.    GLEDIT *.TXT @D:\AGM.TXT "all good men" 
  350.  
  351.   Suppose you want to specify both the search and replace strings in files.
  352. You can create a file with the search string and another with the replace
  353. string and specify both file names in the command line.  Or you can include
  354. two lines in the same file.  The first line would be the search string and 
  355. the second is the replace string.  To tell GLEDIT to look for this arrange-
  356. ment, you specify the same file name in both places in the command line.
  357.  
  358.   For example, if file AGM.TXT looks like this:
  359.  
  360. all good men
  361.  
  362.   and the file QBF.TXT looks like this:
  363.  
  364. quick brown fox
  365.  
  366.   the following command line:
  367.  
  368.    GLEDIT *.TXT @AGM.TXT @QBF.TXT
  369.  
  370.   replaces all occurrences of "all good men" with "quick brown fox".
  371.  
  372.   An alternative would be to create a file, AGMQBF.TXT that contains both 
  373. lines:
  374.  
  375. all good men
  376. quick brown fox
  377.  
  378.   and then use the following command line:
  379.  
  380.    GLEDIT *.TXT @AGMQBF.TXT @AGMQBF.TXT
  381.  
  382.   to achieve the same results.
  383.  
  384.   One last shortcut is to specify the second filename as just @.  This tells
  385. GLEDIT to use the same file for the replace string just as if you had typed
  386. the file name twice.  In other words you can perform the same example as 
  387. above with the following:
  388.  
  389.    GLEDIT *.TXT @AGMQBF.TXT @
  390.  
  391.     
  392.   If you want to actually specify @ or a string that starts with @ as a
  393. search or replace string on the command line, use ~@ as explained in the
  394. next section.
  395.  
  396.  
  397.  
  398. 5.0 Escape Sequences for Special Characters
  399.  
  400.   Sometimes ASCII text files contain some special characters that are not
  401. normally considered text characters.  GLEDIT lets you search and replace
  402. using some of these characters by substituting escape sequences in the 
  403. search/replace strings for these characters.  Please read the notes below
  404. concerning each escape sequence before using them.
  405.   
  406.   The following escape sequences are used within the searchstring and 
  407. replacestring to represent the presence of special characters that either 
  408. cannot be entered on the command line, or may cause problems if they are.
  409. The character following the tilde (~) must be lower case.
  410.  
  411.   ~b = Bell [BEL] (ASCII 7)
  412.   ~e = Escape (ASCII 27)
  413.   ~f = Form feed (ASCII 12)
  414.   ~p = Percent sign [%] (ASCII 37)
  415.   ~n = Line feed (ASCII 10)
  416.   ~q = Double quote ["] (ASCII 34)
  417.   ~r = Carriage return (ASCII 13)
  418.   ~t = Horizontal tab (ASCII 9)
  419.   ~~ = Tilde [~] (ASCII 126)
  420.   ~@ = At [@] (ASCII 64)
  421.  
  422.   NOTES-
  423.  
  424.   ~b - The BEL character causes a beep on the speaker when displayed, but
  425.        does not display as any character.  In order for you to see where it
  426.        is located in the line, the prompts will display the BEL character
  427.        as a heart.  It will not show up at all when /N is specified.
  428.  
  429.   ~e - The ESC character is used to indicate ANSI.SYS and printer escape
  430.        (control) sequences.  To prevent interference with the display,
  431.        the prompts will display the ESC character as a happy face.  It
  432.        will not show up at all when /N is specified.
  433.  
  434.   ~f - The form feed character causes the printer to eject a page.  It shows
  435.        up on the prompt line as circle over a cross, the female sign.  To
  436.        prevent page ejects when routed to a printer, it is omitted from the
  437.        prompt lines when /N is used.
  438.  
  439.   ~p - Using the ~p sequence in place of the percent sign (%) prevents DOS 
  440.        from trying to interpret %1-%9 and paired percent signs as command 
  441.        string and environment variables when GLEDIT is executed within a 
  442.        batch file.  DOS attempts this variable substitution regardless of the
  443.        presence of quotes in the line.  If the variable is not found in the 
  444.        command line or environment, whatever it interprets as a variable 
  445.        vanishes.  This is true even if there are spaces between paired
  446.        percent signs.  This is only necessary to be used in command line
  447.        mode.
  448.  
  449.   ~n - The line feed causes the printer or display to advance one line.
  450.        Inserting a line feed will split a line of text into two lines.
  451.        When adding a ~n you are actually inserting carriage return/line
  452.        feed (CR/LF) pairs.  These CR/LF pairs are found at the end of each
  453.        text file record.  You cannot search for line feeds, but you can
  454.        insert them in the replace string. See the note on ~r.
  455.  
  456.   ~q - Double quotes within the search/replace strings must be entered using
  457.        the ~q escape sequence when in command line mode because otherwise DOS 
  458.        will misinterpret the command line.  The \q which was used in early
  459.        releases is no longer supported.  If using the user interface, the ~q
  460.        is not needed and the " can be entered directly in the search or 
  461.        replace string.  Be aware, however, that quotes which begin or end
  462.        the string are removed.  This allows leading and trailing blanks to 
  463.        be included in the string.
  464.  
  465.   ~r - The carriage return character causes the printer or display cursor to
  466.        return to the start of the current line.  The Borland C++ text mode
  467.        input routines ignore carriage returns, and read in carriage return/
  468.        line feed pairs (CR/LF) as line feed characters.  Thus, a search for
  469.        a carriage return will always fail to find a match.  You may, however
  470.        insert carriage returns by putting them in the replace string.  See
  471.        the note on ~n.
  472.  
  473.   ~t - The horizontal tab character displays or prints a number of spaces
  474.        whenever it is sent to the display or printer.  Usually this defaults
  475.        to 8 spaces, but can be set to other values within many programs.  The
  476.        tab shows up in prompts as a diamond character.
  477.  
  478.   ~~ - You may search for or replace the tilde character by using two tildes
  479.        (~~) to represent one.  If a single tilde is encountered that is not
  480.        followed by one of the above lower case letters, it is treated the
  481.        same as ~~.
  482.  
  483.   ~@ - The @ sign is used to denote input redirection on the command line,
  484.        therefore, if your search or replace string starts with @, you must
  485.        use ~@ instead.  The @ sign can be used elsewhere in the parameter
  486.        without the tilde.
  487.  
  488.   Some uses for special characters include splitting lines by inserting ~n,
  489. replacing tab characters with the desired number of spaces, removing form
  490. feeds from printer files, searching for and replacing laser printer escape
  491. sequences, etc.
  492.  
  493.   If your keyboard does not have a tilde, hold the ALT key down and press
  494. 126 on the keypad.
  495.  
  496.   Most international and graphic characters can be entered in the same
  497. manner, by holding the ALT key and entering the decimal value of the ASCII
  498. code on the numeric keypad.  
  499.  
  500.  
  501.   PLEASE NOTE- Some of the special characters are removed from the records
  502. displayed on the screen due to the unwanted results they might cause when
  503. displayed or redirected to a printer.  These characters are ~b, ~e and ~f.
  504. The characters are present, however, in the records read from or written to
  505. the file.
  506.  
  507.  
  508. 6.0 Operational Notes and Cautions
  509.  
  510.    Please note that GLEDIT is intended for use with ASCII text files that
  511. use the standard CR/LF record delimiters.  If you use it on binary or non-
  512. standard files, the resulting file will probably be unusable.  If you use
  513. GLEDIT on indexed database records and substitute unequal length strings, you
  514. are almost sure to corrupt your database.  GLEDIT does not back up files 
  515. before replacing them, so be careful and be sure of what you are doing.  The
  516. safest approach is to backup the directory, possibly in an archive (.ZIP,
  517. .ARC, etc.) file before editing with GLEDIT.
  518.  
  519.   GLEDIT has two modes of operation, search and edit.  Whenever a replacement
  520. string is specified, edit mode is activated.  If no replacement string is
  521. provided, search mode is invoked unless /D is specified.  /D also invokes
  522. a special edit mode known as delete mode.  In search mode, no file writes
  523. whatsoever take place, therefore no data is modified.  When edit mode is
  524. invoked, a work file is written to the target directory.  As each record is
  525. read in, it is also written to the work file, modified or not.  When GLEDIT
  526. reaches end of file on the input file, it checks to see if you had elected
  527. to make any modifications.  If so, it copies the work file over the input 
  528. file.  The point of relating all of this is that you should not specify a 
  529. replacement string if you are just looking for occurrences of a string.  
  530. Edit mode has much higher overhead.
  531.  
  532.   Please be extremely cautious when using the /Y parameter.  This is for
  533. users who like to live on the edge and believe, "It's my data and I'll
  534. corrupt it if I want to."  A miskeyed command line or not thinking through
  535. what is going to be the result can cause file damage on a vast scale. If
  536. /Y is specified, the only way to stop it is with ESC or CTRL-BREAK.  CTRL- 
  537. BREAK could cause a file to be damaged, so ESC is recommended. Use the
  538. /T switch to test the result before proceeding with /Y.
  539.  
  540.   It is a good idea to use /N and redirect the output to a file or printer
  541. during execution of /Y or /T.  This gives a log of the results.  See Printing
  542. or Saving the Output.
  543.  
  544.   If at any time you wish to abort a search, press the ESC key.
  545.  
  546.   The effects of the /S and /Y switches to scrolling are dependent on the
  547. mode.  Below is a table of valid combinations and what happens when the
  548. parameters are specified.
  549.  
  550.                                   Pause at      Pause when       Prompt for
  551.      MODE         SWITHCES      end of file?   screen full?    replace/delete?
  552.  
  553.  Search                               Y              Y               N/A
  554.  Search           /S                  N              N               N/A
  555.  Replace/Delete                       N              N                Y
  556.  Replace/Delete   /S                  N              N                Y
  557.  Replace/Delete   /Y                  Y              Y                N
  558.  Replace/Delete   /S /Y               N              N                N
  559.  
  560.  Notes: /Y is ignored in search mode.
  561.         /S is equivalent to marking the "Scroll window without pause" box
  562.            in the options window.
  563.         /Y is equivalent to not marking the "Prompt before action" box in 
  564.            the options window.
  565.  
  566.  
  567. 7.0 Locating Data
  568.  
  569.    The primary purpose of GLEDIT is to let you find files that contain certain
  570. strings, generally because the strings need to be modified, but not always.
  571. If you just want to find what files contain a certain string, just enter
  572. the GLEDIT command without a replacement string.
  573.  
  574.    GLEDIT will begin going through the target directory finding each file that
  575. matches the filespec you provided in the command line.  It will search each
  576. of the matching files for the search string you provided.  When found, the
  577. file name will be displayed along with any records in the file containing the
  578. search string.
  579.  
  580.  
  581. 8.0 Modifying Data
  582.  
  583.    Edit mode processing involves everything described under Locating Data
  584. plus you are prompted to reply Y or N depending on whether or not you want
  585. matching records updated as each is displayed.  GLEDIT also displays the
  586. modified line as it will appear if you reply Y.  You can see the result
  587. before you accept it.
  588.  
  589.    If you specify "" as the replace string, any matches of the search string
  590. are deleted from the record.  Please note the difference between this and
  591. the /D switch.  The /D switch or "Delete matching records" option causes the
  592. entire line to be deleted, whereas the "" replace string only causes the
  593. search string to be removed from the current line.
  594.  
  595.  
  596. 9.0 Printing or Saving the Output
  597.  
  598.    To print the output of a search, or an edit using /Y or /T, specify the /N,
  599. and /S if in search mode, parameters and redirect the output to the printer:
  600.  
  601.    GLEDIT *.TXT "MOM" /N /S >PRN
  602.  
  603. or log to a file:
  604.  
  605.    GLEDIT *.BAT "G:" "H:" /N /T >C:\GLEDIT.LOG
  606.  
  607.    You can use >> instead of > if you want the output appended to a log file
  608. instead of creating a new log each time.
  609.  
  610.    Do not use redirection when using edit mode (without /Y or /T) or without 
  611. the /S in search mode.  The resulting pauses will make it appear that GLEDIT 
  612. is hung, since you will not see the prompts.  If this happens, repeatedly 
  613. pressing N will allow GLEDIT to progress to completion.
  614.  
  615. This redirection cannot be used when using the user interface.
  616.  
  617.  
  618. 10.0 Return Codes
  619.  
  620.   The following DOS ERRORLEVEL return codes are returned from GLEDIT:    
  621.     
  622.     0   - One or more matches found.  Replaced or not replaced has no bearing.
  623.     1   - No matches found in any files searched.
  624.     2   - No files found matching the search file specification.
  625.     3   - Invalid path specified in search file specification.
  626.     4   - Directory recursion error.  Please report to Parity Solutions.
  627.           Should never happen.
  628.     255 - User abort.  ESC key pressed.  Does not detect BREAK key.
  629.  
  630.  
  631.  
  632. 11.0 Compatibility with Prior Releases
  633.  
  634.   Versions prior to 2.5 used \q to indicate a quote within a search/replace
  635. string.  This is no longer supported.  The ~q escape sequence is used
  636. instead (command line mode only).
  637.  
  638.   If you have edits set up in batch files or scripts, check them to make sure
  639. that the search and replace strings do not contain any of the allowed escape
  640. sequences.  If they do, replace the tilde (~) with two tildes (~~).  This is
  641. necessary when going from a release prior to 2.5 to release 2.5 or later.
  642. See the section, Escape Sequences for Special Characters.
  643.  
  644.   Very early releases used /D to delete the search object from the record.
  645. This is now accomplished by using "" as the replace string.  Version 4
  646. now uses the /D switch to indicate that matching records should be deleted
  647. altogether.
  648.  
  649.  
  650. 12.0 The GLEDIT.INI Configuration FIle
  651.  
  652.    The GLEDIT.INI file tells GLEDIT what colors to use, what options are the
  653. defaults, et cetera.
  654.  
  655.    A sample GLEDIT.INI file comes with GLEDIT and is initialized to all of
  656. the defaults.  The defaults are used when the GLEDIT.INI file cannot be found
  657. or when a particular setting is missing from the file.
  658.  
  659.    The GLEDIT.INI file can be changed with any text file editor and should be
  660. saved in a directory that is specified in DOS's PATH= environment variable.
  661.  
  662.    As a last resort, if GLEDIT.INI is not found on the path, it also looks in
  663. the same directory from which GLEDIT.EXE was loaded.  Thus, if you keep
  664. GLEDIT.EXE and GLEDIT.INI in the same directory, GLEDIT should never have
  665. trouble locating it.
  666.  
  667.    All of the settings and values for the GLEDIT.INI file are documented
  668. within the GLEDIT.INI file provided with GLEDIT.EXE.  If you wish to add 
  669. comments to the file, the first non-blank character on the line should be 
  670. a semi-colon (;).
  671.  
  672.  
  673. APPENDIX A
  674.  
  675. Installation
  676.  
  677.     GLEDIT is distributed in a self-extracting ZIP file called GLEDT.EXE or
  678. a ZIP file called GLEDIT.ZIP.  It contains the following files:
  679.  
  680.         GLEDIT.EXE         The executable file for GLEDIT.
  681.         GLEDIT.INI         The configuration file for GLEDIT.
  682.         GLEDIT.DOC         The documentation file.
  683.         GLEDIT.HST         History of changes to GLEDIT.
  684.         GLEDIT.HLP         Context-sensitive help file.
  685.         GLEDIT.Vnn         Description of changes to implement version nn,
  686.                            the current version. 
  687.         PRODUCTS.DOC       A text file describing all Parity Solutions 
  688.                            products.
  689.  
  690.     For best results, unzip the file into a directory on your PATH.  If you
  691. don't use a directory in your path, you will have to designate the directory
  692. containing GLEDIT.EXE when executing the program.  Make sure the GLEDIT.INI
  693. and GLEDIT.HLP files stay in the same directory as GLEDIT.EXE.
  694.  
  695.     If you have a utility directory that is on your PATH, this is an excellent
  696. location for GLEDIT.  An example installation would be:
  697.  
  698.     C:
  699.     CD \UTIL
  700.     COPY [path]GLEDT.EXE
  701.     GLEDT
  702.     DEL GLEDT.EXE
  703.  
  704.     or
  705.  
  706.     C:
  707.     CD \UTIL
  708.     COPY [path]GLEDIT.ZIP
  709.     PKUNZIP GLEDIT
  710.     DEL GLEDIT.ZIP
  711.  
  712.    If they are not currently in your path, simply copy all of the files to a 
  713. directory in your path.  Keep the ZIP file anywhere you like, but give plenty 
  714. of copies, as is, to your friends.  If you register GLEDIT, you are not 
  715. licensed to give your serial number to anybody without first removing the 
  716. serialization from your copy.
  717.  
  718.    If you do not desire to keep all the files together in a directory on your
  719. path, please see the "GLEDITFilesPath=" parameter in the GLEDIT.INI file for
  720. instructions on how to tell GLEDIT where your files are located.
  721.  
  722.  
  723.  
  724. APPENDIX B
  725.  
  726.  
  727. Disclaimer
  728.  
  729. BECAUSE OF THE DIVERSE NATURE OF COMPUTER EQUIPMENT AND EXPERTISE OF USERS,
  730. PARITY SOLUTIONS AND GARY C. CRIDER MAKE NO WARRANTY ON THE GLEDIT PROGRAM
  731. WHATSOEVER, EXPRESSED OR IMPLIED.  THE USER ASSUMES ALL RISK OF DAMAGE TO
  732. DATA OR EQUIPMENT RESULTING DIRECTLY OR INDIRECTLY FROM THE USE OR MISUSE OF
  733. THIS PROGRAM PRODUCT.  THE USER MUST BE AWARE THAT USING GLEDIT TO MAKE
  734. ALTERATIONS TO PROGRAMS OR DATA CAN RENDER THAT PROGRAM OR DATA USELESS.
  735.  
  736. USERS ARE ADVISED TO TEST MODIFICATIONS MADE WITH GLEDIT THOROUGHLY ON FILES 
  737. FOR WHICH A BACKUP EXITS.  ANY LIABILITY OF THE AUTHOR OR PARITY SOLUTIONS IS 
  738. LIMITED TO REPLACEMENT OR REFUND OF THE REGISTRATION FEE.
  739.  
  740.  
  741.  
  742.  
  743. APPENDIX C
  744.  
  745.  
  746. Support
  747.  
  748.     I have tried to test the program to the fullest, but I am limited as to
  749. systems and configurations with which to test.  I have been programming for 18
  750. years and the one thing I know for sure is that bug free programs are very few
  751. and far between.  I can only promise to support the program to the best of my
  752. ability and provide fixes as expeditiously as possible.  GLEDIT has been used
  753. at my home and work site extensively for several years and has proven to be a
  754. reliable tool.
  755.  
  756.     Anyone can report problems and suggest changes.  Registered users get top
  757. priority in resolving their problems.  There are three ways you can report
  758. problems.  The preferred method is to contact me through CIS mail (not forum
  759. messages).  My CIS ID is 71760,3413.  You can also write me at:
  760.  
  761.    Gary C. Crider
  762.    Parity Solutions
  763.    1903 Pavia Court
  764.    Arlington, TX 76006
  765.    
  766.     The last method is to phone (817) 261-9552.  Since I am the sole technical
  767. support and the line is also used for my network consulting business, it is
  768. often hard to get through to me.  Please call and leave a message between 7:30
  769. am and 6:30 pm Central time.
  770.  
  771.     No matter which method you use, please give a brief description of your
  772. problem, your registration serial number if you are registered, and your phone
  773. number.  If I need more information, I will contact you as soon as I can.
  774. When I have a solution, I will contact you however you prefer.
  775.  
  776.     I work full time, have a consulting business to run in my spare time and
  777. write programs instead of sleeping.  So please be a little patient with me.
  778.  
  779.     Program updates are available on CompuServe or can be requested from us 
  780. for a $5 shipping and handling charge.  Add $1 for international shipping 
  781. outside the North American continent.  A distribution disk of all Parity 
  782. Solutions products will be sent to you.  Specify disk size and format.  You
  783. may use the order form at the end of this document.
  784.  
  785.  
  786.  
  787. APPENDIX D
  788.  
  789.  
  790. Registration
  791.  
  792.  
  793.     I begin with an apology.  I hate programs that in any way inhibit func-
  794. tionality or performance for the shareware version.  But when it came down to
  795. feeding the family and paying the bills, I had a change of heart and inserted
  796. a pesky notice that pops up at the beginning and gets on your nerves.  I
  797. chose this approach above that of limited functionality.  The program's full
  798. capabilities are available for you to evaluate before you invest your hard-
  799. earned money.
  800.  
  801.     You may use GLEDIT unlicensed for 30 days, after which time you are 
  802. required to be registered.
  803.  
  804.     Registered users will receive a unique serial number and instructions on
  805. how to serialize the program.  Serialization can be re-applied to updated
  806. versions and in no way hinders your use of the program.  You can compress or
  807. decompress the program with no effect (LZEXE or PKLITE).
  808.  
  809.     As a registered user, you will be able to update without re-registration
  810. or additional fees.  You will also be kept on my PRIVATE mailing list to
  811. receive additional information on other Parity Solutions products.  
  812.     
  813.     To register your copy, please use the order form below and send $21 ($85 
  814. per file server on LANs) check or money order (sorry, no credit cards yet) 
  815. to:
  816.  
  817.    Gary C. Crider
  818.    Parity Solutions
  819.    1903 Pavia Court
  820.    Arlington, TX 76006
  821.  
  822.     Please use the order form at the end of this document for your 
  823. convenience and ours.
  824.  
  825.     Purchase orders are acceptable from U.S. and Canadian companies and
  826. institutions.
  827.  
  828.     International orders outside the U.S., Canada and Mexico add $1 to the 
  829. total order for postage.
  830.  
  831.     Or, you can register online quickly and simply on CompuServe.  Simply
  832. GO SWREG and register ID #754.  Your registration will be added to your 
  833. CompuServe bill.  International exchange was never easier and you save the
  834. $1 international postage charge.
  835.  
  836.     If you send your CIS ID or register via SWREG, your registration will be 
  837. sent to you via CIS mail, along with instructions on how to serialize your 
  838. copy of GLEDIT.  This usually involves one day or less turnaround.
  839.     
  840.     Program diskettes are not normally shipped.  Normal distribution is via 
  841. CompuServe.  If you need a diskette, please see the instructions under Support 
  842. above, or use the order form below.  You will receive a serial number and 
  843. instructions for serializing your copy of the program.
  844.     
  845.     Each license gives you or your company a single-use permit for GLEDIT. It 
  846. is not restricted to a single machine as long as no two users can be simul-
  847. taneously using the program.  As Borland says, "treat it like a book."  As an 
  848. example, if you register GLEDIT for your home computer, but during the day you 
  849. use a portable or a computer at work,  you may keep GLEDIT on both machines as 
  850. long as no one is at home using it on your home computer.
  851.  
  852.     LAN licenses grant rights to all users of a file server.  If inter-
  853. networking, a license must exist for each file server that contains a copy
  854. of GLEDIT.EXE.  If two or more file servers exist on a single LAN strictly for
  855. mirroring data and fault-tolerance, these will be counted as a single file
  856. server for licensing purposes.  If in doubt, contact me.  We can work out
  857. an agreement.
  858.  
  859.     Site and enterprise licensing is also available on a negotiated price 
  860. basis.  I guarantee it will be an economical alternative to buying licenses 
  861. for each user.
  862.  
  863.     If you are a registered user of GEDIT from Parity Solutions, you may use
  864. your GEDIT serial number to serialize GLEDIT.
  865.     
  866.     You may freely distribute the original GLEDIT.ZIP file in any way you see
  867. fit other than selling it.  Users' groups and shareware distribution services
  868. may charge a reasonable fee for the medium and duplication costs, not to 
  869. exceed six dollars.  Bulletin boards may not charge additional fees for 
  870. downloading this specific program, other than normal connect-time and/or 
  871. membership charges.
  872.  
  873.     You are NOT licensed to give anyone your serial number unless you first
  874. remove all serialization from your computer.  You may then no longer use that
  875. serial number.  Only Parity Solutions has the authority to issue serial
  876. numbers.
  877.  
  878.     Modification of GLEDIT.EXE in any manner is prohibited and unlawful.
  879.  
  880.     Licensees of Parity Solutions' GEDIT program may serialize GLEDIT by
  881. renaming GEDIT.SER to GLEDIT.SER.
  882.  
  883. ==============================================================================
  884.                 
  885.                           ORDER FORM FOR GLEDIT
  886.  
  887. Send checks or money orders payable to:
  888.  
  889.   Parity Solutions                 
  890.   1903 Pavia Court
  891.   Arlington, TX 76006
  892.  
  893.  
  894.  
  895. BILLING ADDRESS:                        SHIP TO (If different):
  896.  
  897. NAME:    _____________________________  NAME:      ___________________________
  898.       
  899. COMPANY: _____________________________  COMPANY: _____________________________
  900.  
  901. STREET:  _____________________________  STREET:  _____________________________
  902.  
  903.          _____________________________           _____________________________ 
  904.         
  905. CITY/ST: _____________________________  CITY/ST: _____________________________
  906.  
  907. ZIP/POSTAL CODE: _____________________  ZIP/POSTAL CODE: _____________________
  908.  
  909. COUNTRY: _____________________________  COUNTRY: _____________________________
  910.  
  911. PHONE:   _____________________________  PHONE:   _____________________________
  912.  
  913.  
  914. CompuServe/Internet ID: ___________________________________________(optional)
  915.  
  916.  
  917.    NOTE: Parity Solutions sends a serial number for each registration and 
  918.          instructions for serializing your program.  A diskette containing
  919.          the latest releases of all Parity Solutions shareware products is
  920.          available for $5.00 U.S.  The current release of GLEDIT is avail- 
  921.          able for downloading on CompuServe in the PCUTIL forum.
  922.  
  923.  
  924.    QTY   DESCRIPTION                             PRICE EA.   TOTAL PRICE
  925.  
  926.    ___   GLEDIT license and registration           $21.00    ___________
  927.  
  928.    ___   GLEDIT Network license and registration    85.00    ___________
  929.                                                      
  930.    ___   Parity Solutions shareware diskette         5.00    ___________
  931.  
  932.          International postage outside U.S.,         1.00    ___________
  933.          Canada and Mexico.
  934.  
  935.                              
  936.                                           Total Enclosed:    ___________
  937.  
  938.  
  939. Diskette size (if ordered): __ 5.25" 1.2M  __ 3.5" 1.44M
  940.  
  941.  
  942. Thank you for doing business with Parity Solutions.  (817) 261-9552
  943.  
  944. Parity Solutions is a partnership of Gary C. Crider and Russell L. McCloud.  
  945. Federal tax identification number 75-2468376.
  946. ==============================================================================
  947.